home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 65.zip / BS1 part 65 / Delitracker v1.21.adf / Docs / DeliTracker.doc < prev    next >
Text File  |  1992-05-17  |  18KB  |  612 lines
  1.  
  2.  
  3.  
  4. **********************************************************************
  5. *                 DeliTracker V1.21                 *
  6. **********************************************************************
  7.  
  8.  
  9.                 © 1992 by Delirium
  10.                   Date 15.05.1992
  11.  
  12.  
  13.  
  14. =============================== DISCLAIMER ===========================
  15.  
  16.              DeliTracker (c) by Peter Kunath und Frank Riffel.
  17.  
  18. This demoversion of DeliTracker is freely distributable under the
  19. following conditions:
  20.  
  21. Program, document and other files must be distributed in their original
  22. UNMODIFIED form. Of course you can use an archiver like LHarc to make
  23. it available on mailboxes and FTP sites. This program cannot be used
  24. for commercial purposes without written permission from the authors.
  25. The program may be distributed as long as the copying fee is not higher
  26. than $6. The authors can not be made responsible for any damage which
  27. is caused by using this program.
  28.  
  29. If you like to have the full version send
  30.  
  31.     DM20    if you are inside Germany
  32.     $US20    if you are not in Germany
  33.  
  34. (cash only, no cheques) along with the registration form to the
  35. following address:
  36.  
  37.     Frank Riffel
  38.     Merkstr. 27
  39.     8129 Wessobrunn
  40.     Germany
  41.  
  42.  
  43. ========================== What is DeliTracker ? =====================
  44.  
  45. DeliTracker is a soundplayer, which supports several soundformats.
  46. SoundTracker 15 inst., SoundTracker 31 inst., NoiseTracker, ProTracker,
  47. StarTrekker without AM sounds and CustomPlay are internal players.
  48. Additional Players are loaded from disk. This means that you can very
  49. easily add/update players by placing them into the DeliPlayers directory.
  50. DeliTracker is NOT a Songeditor, MIDIsequencer or Digitizer. It is
  51. only thought to play music modules in a comfortable way.
  52.  
  53.  
  54. ========================== Why use DeliTracker ? =====================
  55.  
  56.     ° runs fine in multitasking
  57.     ° allocates the soundchannels
  58.     ° correct playspeed in PAL/NTSC (uses timerinterrupts)
  59.     ° works well with serial.device
  60.     ° supports PowerPacked and Imploded soundfiles
  61.     ° supports up to 64 players
  62.     ° runs fine with 680x0 and Kick2.0
  63.     ° uses & requires req.library
  64.     ° Arexx support
  65.     ° has a configfile
  66.     ° enforcer and mungwall proof
  67.     ° supports full CLI or Workbench (ToolTypes) environment
  68.     ° easy to use & looks good
  69.     ° has Volume/Balance - slider
  70.     ° resident cli startup
  71.     ° supports multiselect
  72.     ° written 100% in Assembler
  73.     ° ... and is programmed by Delirium Softdesign
  74.  
  75.  
  76. ================================= Settings ===========================
  77.  
  78. Getting Started
  79.  
  80. Make sure that the req.library is in LIBS:
  81. DeliTracker my be configured at startup time with the following options:
  82.  
  83. Option            Default value and description 
  84. ----------------------  -----------------------------
  85.  
  86. config <file>        'ENV:DeliTracker.config'
  87.             loads the specified file as a configuration file
  88.  
  89. module <file>        No file, empty module list
  90.             Adds the <file> to the module list
  91.  
  92. playerpath <path>    'DeliPlayers'
  93.             Sets the path where DeliTracker loads the external 
  94.             players.
  95.  
  96. windowxy<XPos>/<YPos>    0/0
  97.             Attempts to open the mainwindow at the given position.
  98.             If this fails the window will be opened at 0/0.
  99.  
  100. prefwinxy<XPos>/<YPos>    0/1
  101.             Attempts to open the prefswindow at the given position.
  102.             If this fails the window will be opened at 0/1.
  103.  
  104. volume    <volume>    64 (maximal volume)
  105.             Sets the volume to <volume>. Where volume can range
  106.             from 0 to 64.
  107.             
  108. balance <balance>    0
  109.             Sets the balance to <balance>. Where balance can range 
  110.             from -64 (left channels only) to 64 (right channels
  111.             only)
  112.  
  113. reqlines <lines>    0 (requester internal default setting)
  114.             Specifies the filerequester height in lines.
  115.  
  116. subsong <number>    0 (first subsong)
  117.             Sets the subsong counter to <number> if the player for
  118.             the first module in the soundlist supports subsongs.
  119.  
  120. playing <bool>        1 (first module is playing)
  121.             Defines if the first module in the soundlist should be
  122.             played, when DeliTracker is started.
  123.  
  124. window <bool>        1 (mainwindow is visible)
  125.             This option lets you specify if DeliTracker should
  126.             open its mainwindow at startup time. (Note: You can
  127.             only supress the mainwindow from opening, if the
  128.             AREXX-Server is running)
  129.     
  130. filter <bool>        0 (filter off)
  131.             Switches the internal lowpass filter on or off.
  132.             (Note: On A1000 this switch has no effect)
  133.  
  134. quick <bool>        1 (module is played immediately after loading)
  135.             Defines if a loaded module should begin to play
  136.             immediately after loading or if the module is in a
  137.             paused state. This option is thought for
  138.             synchronisation purposes in ARexxscripts.
  139.  
  140. random <bool>        0 (sequential order)
  141.             Lets you specify weather a Next/Prev-Song event should
  142.             take a randomly picked or the following (preceeding)
  143.             list entry for loading. This option has only sense if
  144.             there are more than 2 entrys in the modulelist.
  145.  
  146. append <bool>        0 (replace modulelist with new selection)
  147.             Lets you specify wether the soundlist should be
  148.             appended at the end or replaced by the current
  149.             selection. If this option is set a multiselect of
  150.             modules from different directories is possible.
  151.  
  152. songend <bool>        0 (ignore songend signals)
  153.             Lets you specify wether songend events should be
  154.             ignored or not. SOME players support a notification
  155.             of the song end. If this option is set DeliTracker
  156.             will pause the module and load the next module in
  157.             the list. If only one module is in the soundlist then
  158.             it is paused after the song has played once.
  159.  
  160. timeout <secs>        0 (no timeout)
  161.             Lets you specify the amount of time (in secs) after
  162.             that DeliTracker will cause a Next-Song event. This
  163.             function can be disabled with a value of 0.
  164.  
  165. The options are not case sensitive!
  166.  
  167.  
  168. Starting from the CLI
  169.  
  170. Open a Shell or CLI window and CD to the directory where DeliTracker is
  171. located. Now you can type 'DeliTracker' followed by none/one/more option(s)
  172. explained above. The options must be separated by a space from the arguments.
  173. If a wrong arument is supplied DeliTracker quits with a short helptext.
  174.  
  175. Example: 'DeliTracker config DT.config reqlines 18 volume 32 filter 1'
  176.  
  177.  
  178. Starting from the Workbench
  179.  
  180. Open the drawer that contains DeliTracker and start it with a doubleclick.
  181. All options can be set as ToolTypes by using the 'Info'-item from the
  182. Workbench. The options must be separated by a '=' from the arguments.
  183. Invalid Tooltypes are ignored. DeliTracker can be used as 'Default Tool'.
  184.  
  185. Example:
  186.     Config=DT.config
  187.     PrefWinXY=0/11
  188.     Volume=43
  189.     Window=0
  190.  
  191.  
  192.  
  193. The Configuratrion File
  194.  
  195. A Configuration file contains one or more options with the appropriate
  196. arguments. The only option that is not possible is the 'config' option.
  197. Only one option per line is allowed. You may add comments with ';'.
  198. DeliTracker can create configfiles with the save functions from the
  199. prefswindow. Another way is to create a config file by your own with
  200. an editor or automatically by using the following NewList alias:
  201. 'alias ModList NL -hTigfsF "module=\'%P\'" []'.
  202.  
  203. Example of a configfile:
  204.  
  205. ; my first config(sm|f)ile
  206. windowxy=473/15
  207. random=1
  208. songend=1
  209. timeout=300
  210. reqlines=50
  211. subsong=2
  212. playerpath="Data:DeliPlayers"
  213. ;
  214. ; modules follow here
  215. ; 
  216. module="Data:Modules/SonicArranger/MF__Slowmotion1.3.pp"
  217. module="Data:Modules/FutureComposer13/hidden part.pp"
  218.  
  219.  
  220. Tooltypes and CLI options have higher predency than the options in a config
  221. file. At startup time DeliTracker tries to open 'ENV:DeliTracker.config' as
  222. default configfile.
  223.  
  224.  
  225. =============================== PLAYERS ==============================
  226.  
  227. Supported players:
  228.  
  229.     ° ProTracker/NoiseTracker/SoundTracker15/SoundTracker31/and
  230.       StarTrekker w/o AM sounds. INTERNAL
  231.  
  232.     ° CustomPlay for special modules which contain their player
  233.       (these can't be crunched, they are loaded via LoadSeg() for
  234.       relocation). INTERNAL
  235.  
  236.     ° all EXTERNAL players are listed in the Players.doc file
  237.  
  238.  
  239. ============================= PACKED MODULES =========================
  240.  
  241. DeliTracker automatically detects and decrunches powerpacked and imploded
  242. files.
  243. NOTE: Don't pack custommodules because they are loaded and relocated
  244. via LoadSeg() in oposition to Read(). Furthermore you are not allowed to
  245. crunch modules of a player if 'Packable....NO' is shown in the player
  246. info field for this particular player. This is because the player itself
  247. loads the files rather then using the internal LoadFile() function.
  248.  
  249.  
  250. ============================== Kickstart 2.0 =========================
  251.  
  252. The Version for Kickstart 2.0 has some differences to the 1.3 Version:
  253.  
  254.     ° the colors are modified for 2.0
  255.     ° the mainwindow has a Zip-Gadget
  256.     ° you can select/play a module by simply dragging the module
  257.       icon over the mainwindow from DeliTracker (appwindow).
  258.  
  259.  
  260. ================================= Gadgets ============================
  261.  
  262.      +----------+--+-------------------------------------------------------+--+
  263.      |        |  |                            [] |  | [15]
  264.  [1] |      ?    +  +-------------------------------------------------------+  +
  265.      |        |  |                   []               |  | [14]
  266.      +---+------+--+--+------+------+------+-----+------+------+-----+-----+--+
  267.  [2] | + |    |     |         |        |       |     |    |      |     |    |¯¯\  |
  268.      +---+  |<    |  <  |     <<  |    |>  |  >>  |  >     |  >|    |  []  |  ^  |    |  |  |
  269.  [3] | - |    |     |         |        |       |     |    |      |  ¯  |    +--+  |
  270.      +---+------+-----+------+------+------+-----+------+------+-----+--------+
  271.        [4]      [5]     [6]   [7]    [8]    [9]   [10]      [11]     [12]    [13]
  272.  
  273.  
  274.  [1]    open/close Prefs-Window
  275.  [2]    plays song a little faster
  276.  [3]    plays song a little slower
  277.  [4]    previous song (only if more than one file is selected)
  278.  [5]    previous pattern / sub song
  279.  [6]    previous sub-song (if available)
  280.  [7]    play/pause song
  281.  [8]    next pattern / sub song
  282.  [9]    next song (only if more than one file is selected)
  283. [10]    next sub-song (if available)
  284. [11]    stop song, reset patterncounter, reset speed
  285. [12]    remove song from memory
  286. [13]    filerequester
  287.     If enough memory is available DeliTracker will use DoubleBuffering
  288.     (that means a song will played until the next song is loaded).
  289. [14]    balance control
  290. [15]    volume control
  291.  
  292.  
  293. ================================ Shortcuts ===========================
  294.  
  295. Nearly all functions that DeliTracker offers can be reached via a 
  296. Shortcut. To make the shortcuts easy to remember all functions of the 
  297. mainwindow are found on the numeric keypad. The functions of the 
  298. prefswindow are the first letter of the function. Note: Shortcuts will
  299. only work if the right window is active.
  300.  
  301. Shortcuts for the mainwindow:
  302.  
  303. /    - preferences-window comes up
  304.  
  305. *    - pops loadrequestor up (use SHIFT for selecting more files)
  306.  
  307. 0    - play/pause
  308.  
  309. 1    - stop song (reset patternpointer, reset speed)
  310.  
  311. +    - increases playspeed
  312.  
  313. -    - decreases playspeed
  314.  
  315. 5    - set patternpointer to next pattern
  316.  
  317. 6    - set patternpointer one pattern back
  318.  
  319. ] and )    - play next song (if more files selected)
  320.  
  321. [ and (    - play previous song    -"-
  322.  
  323. 8    - play next subsong
  324.  
  325. 7    - play previous subsong
  326.  
  327. .    - stop playing, remove sound from memory
  328.  
  329. 9    - decreases the volume
  330.  
  331. 6    - increases the volume
  332.  
  333. 2    - changes the balance in such a way that the left channels 
  334.       will be played louder
  335.  
  336. 3    - changes the balance in such a way that the right channels 
  337.       will be played louder
  338.  
  339.  
  340. Shortcuts for the prefswindow:
  341.  
  342. f    - toggle filter
  343.  
  344. q    - toggle quickstart
  345.  
  346. r    - toggle randomplay
  347.  
  348. e    - toggle songend detection
  349.  
  350. p    - toggle append
  351.  
  352. t    - activate time gadget
  353.  
  354. a    - add an external player
  355.  
  356. d    - delete selected player
  357.  
  358. l    - load a configfile
  359.  
  360. s    - save a configfile
  361.  
  362. c    - configure selected player (if possible)
  363.  
  364. o    - leave setupwindow
  365.  
  366.  
  367. <rcommand> q quits DeliTracker. This shortcut is valid for both windows.
  368.  
  369.  
  370. ============================== Preferences ===========================
  371.  
  372. If you press the '?'-Gadget a preferences-window pops up. If you select
  373. a Player some information about this player is shown in the 'playerinfo'
  374. box. Other informations about external Players can be found in the
  375. 'Programming.doc', the Player docs and in 'misc/DeliPlayers.i'.
  376.  
  377. ADD            - Load an external player and set the playerpath.
  378.               If a player with the same name is already loaded,
  379.               the player with the lower version number will be
  380.               expunged.
  381.  
  382. DEL            - delete selected player (free mem)
  383.  
  384. Filter            - refer to settings (filter)
  385.  
  386. Quick            - refer to settings (quick)
  387.  
  388. Random            - refer to settings (random)
  389.  
  390. Songend            - refer to settings (songend)
  391.  
  392. Append            - refer to settings (append)
  393.  
  394. Time            - refer to settings (timeout)
  395.  
  396. Load Config        - load and execute a saved configuration
  397.  
  398. Save Config        - save the current settings and the module list
  399.               in a configfile
  400.  
  401. Save List        - save only the current module list in a configfile
  402.  
  403. Config Player        - configure the selected player (currently no
  404.               player uses this feature; is is used to 
  405.               provide a player private configuration i.e a 
  406.               SMUS player could ask you in which dirs to 
  407.               search for the instruments).
  408.  
  409. OK            - close this window
  410.  
  411.  
  412. You can set the playerdirectory by typing the path into the stringgad
  413. (on the lefthand of the ADD gadget) or using the filerequester (ADD).
  414.  
  415.  
  416. ============================ REXXCOMMANDS ============================
  417.  
  418. Square brackets mark arguments that may be omitted. All other arguments
  419. must be supplied. See also the REXX examples.
  420.  
  421. quit            - quit DeliTracker 
  422.  
  423. filter <BOOL>        - if BOOL = 0 then set filter off else on
  424.  
  425. quick <BOOL>        - if BOOL = 0 then set quickstart off else on
  426.  
  427. random <BOOL>        - if BOOL = 0 then set random off else on
  428.  
  429. songend <BOOL>        - if BOOL = 0 then set songend off else on
  430.  
  431. append <BOOL>        - if BOOL = 0 then set append off else on
  432.  
  433. timeout <SECS>        - set timeout to <SECS>
  434.  
  435. volume <VOL>        - Set volume to <VOL> (VOL: 0 to 64) if possible
  436.  
  437. balance <BAL>        - Set balance to <BAL>, 0 is default, -64 left
  438.               only 64 right only (BAL: -64 to 64) if possible
  439.  
  440. forward            - play next pattern
  441.  
  442. backward        - play previous pattern
  443.  
  444. nextsong        - play next song
  445.  
  446. prevsong        - play previous song
  447.  
  448. nextsubsong        - play next subsong
  449.  
  450. prevsubsong        - play previous subsong
  451.  
  452. faster            - increase playspeed
  453.  
  454. slower            - decrease playspeed
  455.  
  456. loadconfig [FILE]    - Load configfile [FILE] if [FILE] was specified
  457.               else pop filerequester up
  458.  
  459. saveconfig [FILE]    - Save configfile [FILE] if [FILE] was specified
  460.               else pop filerequester up
  461.  
  462. savelist [FILE]        - Save module list to [FILE] if [FILE] was specified
  463.               else pop filerequester up
  464.  
  465. loadplayer [PLAYER]    - Load the [PLAYER] if specified, else open loadplayer
  466.               requester
  467.  
  468. deleteplayer <NUMBER>    - Remove player number <NUMBER> from memory
  469.  
  470. configplayer <NUMBER>    - Call the configuration routine of the player <NUMBER>
  471.  
  472. playmod [MODULE]    - play [MODULE] if [MODULE] was specified else pop
  473.               requester up
  474.  
  475. playpause        - play/pause song
  476.  
  477. stop            - stop song
  478.  
  479. eject            - remove active module from memory
  480.  
  481. openmainwin        - open mainwindow
  482.  
  483. closemainwin        - close mainwindow
  484.  
  485. openprefswin        - open prefs-window
  486.  
  487. closeprefswin        - close prefs-window
  488.  
  489.  
  490. status    <group> <dependent> - group may be p, m, g
  491.  
  492.     p :    player
  493.  
  494. <dependent>  =    <playernum> <cmd>
  495.  
  496.            <cmd>        returnvalue
  497.  
  498.         nam        name string
  499.         cre        creator string
  500.         ver        player version number
  501.         vol        volume    0/1
  502.         bal        balance 0/1
  503.         jmp        patternjump 0/1
  504.         spd        playspeed 0/1
  505.         sub        subsong 0/1
  506.         cfg        config    0/1
  507.         pck        packable 0/1
  508.  
  509.     g :    global
  510.  
  511. <dependent>  =    <cmd>
  512.  
  513.         <cmd>        returnvalue
  514.  
  515.         ver        version number
  516.         dir        playdir string
  517.         num        players number
  518.         led        filter 0/1
  519.         qst        quickstart 0/1
  520.         rnd        random 0/1
  521.         app        append 0/1
  522.         end        songend    0/1
  523.         tim        timeout number (secs)
  524.         mwi        Main 0/1
  525.         pwi        Prefs 0/1
  526.         vol        current volume number
  527.         bal        current balance number
  528.         ply        song is playing or paused
  529.  
  530.     m :    Module
  531.  
  532. <dependent>  =    <cmd>
  533.  
  534.         <cmd>        returnvalue
  535.  
  536.         dir        moduledir string
  537.         fil        filename string
  538.         pnr        actual PlayerNr number
  539.         max        selected modules number
  540.         num        actual position in list number
  541.  
  542.  
  543. ========================= Problems/Hints/Tricks ======================
  544.  
  545. Symptom: Preferences window can't be opened. Check the Screenheight.
  546.      It must be at least 190 Pixel + Barheight.
  547.      The Barheigth depends on the Screenfontheight.
  548.  
  549. NOTE:     Some external players have trouble with >68010 or SuperHires
  550. these problems often can't be fixed. The cause of this lies in the
  551. programmingstyle (e.g the player is part of the module and contains
  552. modulespecific code/data). Although many players are hitting the basic
  553. principles of programming on the amiga. Such things as poking directly
  554. into processorvectors or working with nullpointers are used often. So
  555. don't be astonished if enforcer hits occur. These hits are only from
  556. external players and not from DeliTracker itself !!! Usually the 
  557. playspeed of the players are the same on PAL/NTSC machines cause a CIA 
  558. rather than a VBlank IRQ is used. But some Players essentially need a 
  559. VBlank interrupt, those players have different playspeeds depending on 
  560. the selected video mode (PAL/NTSC/Productivity).
  561.  
  562. For Modem users: All players that use the DeliTracker internal timer 
  563. Interrupt should now work well with serial transfers. Players that
  564. generate their own timer interrupt will probably not(!). This is due 
  565. to the fact that instead of executing the actual playroutine in the
  566. timer interrupt itself, we cause a SoftInt (so that the real routine 
  567. executes in a lower interrupt priority than the RFB interrupt).
  568.  
  569.  
  570. ================================= CREDITS ============================
  571.  
  572. We want to thank the following people:
  573.  
  574.  - Our betatesters Stefan, Daniel, Börnie and Manfred for their
  575.    bugreports and some good ideas
  576.  
  577.  - Armin Sander (Oktalyzer) and Carsten Schlote (Sonic Arranger)
  578.    for creating a player for DeliTracker.
  579.  
  580.  - all on #amiga (IRC), especially Markus Illenseer.
  581.  
  582.  - Colin Fox and Bruce Dawson for the incredibile req.library.
  583.  
  584.  - and all others, who have send replays and modules.
  585.  
  586.  
  587. Testconfigurations:
  588.  
  589.  - A500 KS1.3, 512k
  590.  - A500 KS1.2, 1MB
  591.  - A500 KS1.3, 1MB (Chip)
  592.  - A500 KS1.2, 2.3MB
  593.  - A500 KS1.2, 2.5MB & Harddisk
  594.  - A2000 KS1.2, 1MB
  595.  - A2000 KS1.3, 1MB & Harddisk
  596.  - A2000 KS1.3, 3MB (1MB Chip) & Harddisk
  597.  - A2500 KS1.3, 5MB (1MB Chip) & Harddisk
  598.  - A3000 KS1.3, 10MB & Harddisk
  599.  - A3000 KS2.04, 10MB & Harddisk
  600.  
  601.  
  602. ======================================================================
  603.  
  604. If you find any BUGS, have SUGGESTIONS or REMARKS about this program,
  605. or have a new player please LET ME KNOW.
  606.  
  607.                    Frank Riffel
  608.                 Merkstr. 27
  609.                   8129 Wessobrunn
  610.                   Germany
  611.  
  612.